Ein Dokument mit einem oder mehreren Tab
-Objekten, die jeweils RTF- und
wie Tabellen und Listen.
Dokumente können mit DocumentApp
geöffnet oder erstellt werden.
// Open a document by ID. var doc = DocumentApp.openById("<my-id>"); // Create and open a document. doc = DocumentApp.create("Document Title");
Methoden für die Document
-Klasse, die direkt auf Textinhalte zugreifen und diese ändern, funktionieren bei
entweder der aktive Tab (in Skripts gebunden an ein
bestimmte Dokumente) oder auf den ersten Tab (falls kein aktiver Tab verfügbar ist). Skripts, die sich auf
können diese Methoden (z. B. getBody()
) migriert werden, damit Tabs unterstützt werden:
getTabs()
und dann Tab.asDocumentTab()
.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addBookmark(position) | Bookmark | Fügt dem ersten Tab ein Bookmark am angegebenen Position hinzu. Für Skripts, die
gebunden an ein Dokument, den aktiven Tab. |
addEditor(emailAddress) | Document | Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu. |
addEditor(user) | Document | Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu. |
addEditors(emailAddresses) | Document | Fügt das angegebene Array von Nutzern der Liste der Bearbeiter für Document hinzu. |
addFooter() | FooterSection | Fügt dem ersten Tab einen Fußzeilenbereich hinzu, sofern keiner vorhanden ist. Bei Skripts, die an ein Dokument gebunden sind, wird der aktive Tab hinzugefügt. |
addHeader() | HeaderSection | Fügt dem ersten Tab einen Kopfzeilenabschnitt hinzu, sofern keiner vorhanden ist. Bei Skripts, die an ein Dokument gebunden sind, wird der aktive Tab hinzugefügt. |
addNamedRange(name, range) | NamedRange | Fügt ein NamedRange hinzu. Dabei handelt es sich um eine Range mit einem Namen und einer ID zur Verwendung für
spätere Abruf auf dem ersten Tab oder bei Skripts, die an ein Dokument gebunden sind, im aktiven Tab. |
addViewer(emailAddress) | Document | Fügt den angegebenen Nutzer der Liste der Betrachter für das Document hinzu. |
addViewer(user) | Document | Fügt den angegebenen Nutzer der Liste der Betrachter für das Document hinzu. |
addViewers(emailAddresses) | Document | Fügt das angegebene Array von Nutzern der Betrachterliste für Document hinzu. |
getActiveTab() | Tab | Ruft die derzeit aktive Tab des Nutzers im Dokument ab. |
getAs(contentType) | Blob | Ruft den aktuellen Document -Inhalt als Blob des angegebenen Typs ab. |
getBlob() | Blob | Ruft den aktuellen Document -Inhalt als Blob ab. |
getBody() | Body | Ruft den Body des ersten Tabs oder bei Skripts, die an ein Dokument gebunden sind, den DocumentBodySection des aktiven Tabs ab. |
getBookmark(id) | Bookmark | Ruft das Bookmark mit der angegebenen ID im ersten Tab oder, im Fall von Skripts, die an ein Dokument gebunden sind, den aktiven Tab ab. |
getBookmarks() | Bookmark[] | Ruft alle Bookmark -Objekte im ersten Tab oder im Fall von Skripts, die an ein Dokument gebunden sind, im aktiven Tab ab. |
getCursor() | Position | Ruft den Cursor des Nutzers im aktiven Tab ab. |
getEditors() | User[] | Ruft die Liste der Bearbeiter für dieses Document -Element ab. |
getFooter() | FooterSection | Ruft den Fußzeilenbereich des ersten Tabs oder bei Skripts, die an ein Dokument gebunden sind, die Fußzeile des aktiven Tabs ab . |
getFootnotes() | Footnote[] | Ruft alle Footnote -Elemente im Body des ersten Tabs oder im Fall von Skripts, die an ein Dokument gebunden sind, im Body des aktiven Tabs ab. |
getHeader() | HeaderSection | Ruft den Kopfzeilenbereich des ersten Tabs oder, im Fall von Skripts, die an ein Dokument gebunden sind, den Header des aktiven Tabs ab . |
getId() | String | Ruft die eindeutige Kennung des Dokuments ab. |
getLanguage() | String | Ruft den Sprachcode des Dokuments ab. |
getName() | String | Ruft den Titel des Dokuments ab. |
getNamedRangeById(id) | NamedRange | Ruft das NamedRange mit der angegebenen ID im ersten Tab oder, im Fall von Skripts, die an ein Dokument gebunden sind, den aktiven Tab ab. |
getNamedRanges() | NamedRange[] | Ruft alle NamedRange -Objekte im ersten Tab oder im Fall von Skripts, die an ein Dokument gebunden sind, im aktiven Tab ab. |
getNamedRanges(name) | NamedRange[] | Ruft alle NamedRange -Objekte mit dem angegebenen Namen im ersten Tab oder für Skripts ab, die
an ein Dokument gebunden sind, den aktiven Tab. |
getSelection() | Range | Ruft die Auswahl des Nutzers auf dem aktiven Tab ab. |
getSupportedLanguageCodes() | String[] | Ruft alle Sprachcodes ab, die in Google Docs-Dateien unterstützt werden. |
getTab(tabId) | Tab | Ruft die Tab mit der angegebenen ID ab. |
getTabs() | Tab[] | Ruft alle nicht verschachtelten Tab s ab, die Teil des Dokuments sind. |
getUrl() | String | Ruft die URL für den Zugriff auf das aktuelle Dokument ab. |
getViewers() | User[] | Ruft die Liste der Betrachter und Kommentatoren für dieses Document ab. |
newPosition(element, offset) | Position | Erstellt eine neue Position , die ein Verweis auf eine Position auf dem Tab ist, relativ zu einem
ein bestimmtes Element auf dem ersten Tab oder bei Skripts, die an ein Dokument gebunden sind, im aktiven Tab. |
newRange() | RangeBuilder | Erstellt einen Builder, der zum Erstellen von Range -Objekten aus Tab-Elementen im
1. Tab oder für Skripts, die an ein gebundenes
der aktive Registerkarte. |
removeEditor(emailAddress) | Document | Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document . |
removeEditor(user) | Document | Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document . |
removeViewer(emailAddress) | Document | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Document . |
removeViewer(user) | Document | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Document . |
saveAndClose() | void | Speichert den aktuellen Document . |
setActiveTab(tabId) | void | Legt das vom Nutzer ausgewählte Tab im aktuellen Dokument auf den Tab mit der angegebenen ID fest. |
setCursor(position) | Document | Legt den Cursor des Nutzers bei Angabe eines Position fest. |
setLanguage(languageCode) | Document | Legt den Sprachcode des Dokuments fest. |
setName(name) | Document | Legt den Titel des Dokuments fest. |
setSelection(range) | Document | Legt die Auswahl des Nutzers auf dem aktiven Tab fest, wenn eine Range angegeben wird. |
Detaillierte Dokumentation
addBookmark(position)
Fügt dem ersten Tab ein Bookmark
am angegebenen Position
hinzu. Für Skripts, die
gebunden an ein Dokument, den aktiven Tab. So fügen Sie ein
Lesezeichen für einen beliebigen Tab hinzufügen, verwenden Sie die Methode DocumentTab.addBookmark(position)
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the active or first tab's body and adds a paragraph. const paragraph = doc.getBody().appendParagraph('My new paragraph.'); // Creates a position at the first character of the paragraph text. const position = doc.newPosition(paragraph.getChild(0), 0); // Adds a bookmark at the first character of the paragraph text. const bookmark = doc.addBookmark(position); // Logs the bookmark ID to the console. console.log(bookmark.getId()); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
position | Position | Die Position des neuen Lesezeichens. |
Rückflug
Bookmark
: Das neue Lesezeichen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(emailAddress)
Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document
hinzu. Wenn der Nutzer
wird der Nutzer mit dieser Methode aus der Betrachterliste hochgestuft.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des hinzuzufügenden Nutzers. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(user)
Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document
hinzu. Wenn der Nutzer
wird der Nutzer mit dieser Methode aus der Betrachterliste hochgestuft.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Darstellung des hinzuzufügenden Nutzers. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditors(emailAddresses)
Fügt das angegebene Array von Nutzern der Liste der Bearbeiter für Document
hinzu. Wenn eines der
Nutzer, die bereits auf der Liste der Betrachter stehen, werden sie mit dieser Methode aus der Liste der
Zuschauer*innen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddresses | String[] | Ein Array mit E-Mail-Adressen der Nutzer, die hinzugefügt werden sollen. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addHeader()
Fügt dem ersten Tab einen Kopfzeilenabschnitt hinzu, sofern keiner vorhanden ist. Bei Skripts, die an ein Dokument gebunden sind, wird der aktive Tab hinzugefügt. So fügen Sie eine Kopfzeile hinzu:
Bereich zu einem beliebigen Tab hinzufügen, verwenden Sie die Methode DocumentTab.addHeader()
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Adds a header to the document's active or first tab. const header = doc.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
Rückflug
HeaderSection
: Der Header des Tabs.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addNamedRange(name, range)
Fügt ein NamedRange
hinzu. Dabei handelt es sich um eine Range
mit einem Namen und einer ID zur Verwendung für
spätere Abruf auf dem ersten Tab oder bei Skripts, die an ein Dokument gebunden sind, im aktiven Tab. Wenn Sie einem beliebigen Tab ein NamedRange
hinzufügen möchten, verwenden Sie die Methode DocumentTab.addNamedRange(name, range)
. Namen sind nicht
unbedingt einzigartig sind; Mehrere Bereiche im selben Dokument können denselben Namen haben, sehr viel
wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig, ähnlich wie eine ID in HTML.
Wenn Sie einem Dokument ein NamedRange
-Element hinzugefügt haben, können Sie es nicht mehr ändern, sondern nur wieder entfernen.
Jedes Skript, das auf das Dokument zugreift, kann auf ein NamedRange
zugreifen. So vermeiden Sie unbeabsichtigte
Konflikten zwischen Skripts besteht, sollten Sie Bereichsnamen eine eindeutige Zeichenfolge voranstellen.
// Creates a named range that includes every table in the active tab. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } // Adds the named range to the document's active tab. doc.addNamedRange('Document tables', rangeBuilder.build());
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Der Name für den Bereich, der nicht eindeutig sein muss. Bereichsnamen müssen zwischen 1 und 256 Zeichen. |
range | Range | Der Bereich der Elemente, die mit dem Namen verknüpft werden sollen. Der Bereich kann die aktive Auswahl, ein Suchergebnis oder ein manuell mit newRange() erstelltes Feld sein. |
Rückflug
NamedRange
: Der NamedRange
.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(emailAddress)
Fügt den angegebenen Nutzer der Liste der Betrachter für das Document
hinzu. Wenn der Nutzer
auf der Liste der Bearbeiter enthält, hat diese Methode keine Auswirkungen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des hinzuzufügenden Nutzers. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(user)
Fügt den angegebenen Nutzer der Liste der Betrachter für das Document
hinzu. Wenn der Nutzer
auf der Liste der Bearbeiter enthält, hat diese Methode keine Auswirkungen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Darstellung des hinzuzufügenden Nutzers. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewers(emailAddresses)
Fügt das angegebene Array von Nutzern der Betrachterliste für Document
hinzu. Wenn eines der
Benutzer, die bereits auf der Liste der Bearbeiter waren, hat diese Methode keine Auswirkungen auf sie.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddresses | String[] | Ein Array mit E-Mail-Adressen der Nutzer, die hinzugefügt werden sollen. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getActiveTab()
Ruft die derzeit aktive Tab
des Nutzers im Dokument ab. Ein Skript kann nur auf die
aktiven Tab des Nutzers, der das Skript ausführt, und nur, wenn das Skript an das Dokument gebunden ist.
// Display a dialog box that shows the title of the tab that the // user is currently viewing. const tab = DocumentApp.getActiveDocument().getActiveTab(); DocumentApp.getUi().alert('ID of selected tab: ' + tab.getTitle());
Rückflug
Tab
: Der derzeit aktive Tab
des Nutzers oder null
, wenn das Skript nicht an folgende Adresse gebunden ist:
des Dokuments.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(contentType)
Ruft den aktuellen Document
-Inhalt als Blob des angegebenen Typs ab.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the document as a PDF. const pdf = doc.getAs('application/pdf'); // Logs the name of the PDF to the console. console.log(pdf.getName());
Parameter
Name | Typ | Beschreibung |
---|---|---|
contentType | String | Der MIME-Typ, in den konvertiert werden soll; 'application/pdf' und 'text/markdown' werden unterstützt. |
Rückflug
Blob
– Das aktuelle Dokument als Blob.
getBlob()
Ruft den aktuellen Document
-Inhalt als Blob ab.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Retrieves the current document's contents as a blob and logs it to the console. console.log(doc.getBlob().getContentType());
Rückflug
Blob
– Das aktuelle Dokument als Blob.
getBody()
Ruft den Body
des ersten Tabs oder bei Skripts, die an ein Dokument gebunden sind, den DocumentBodySection
des aktiven Tabs ab. Zum Abrufen des DocumentBodySection
eines beliebigen Tabs verwenden Sie die Methode DocumentTab.getBody()
.
Tabs können verschiedene Arten von Bereichen enthalten, z. B. HeaderSection
und FooterSection
. Der aktive Bereich für einen Tab ist Body
.
Elementmethoden in Document
werden an die aktive Body
delegiert.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the active or first tab's body. const body = doc.getBody(); // Gets the body text and logs it to the console. console.log(body.getText());
Rückflug
Body
: Der Tab-Textbereich.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmark(id)
Ruft das Bookmark
mit der angegebenen ID im ersten Tab oder, im Fall von Skripts, die an ein Dokument gebunden sind, den aktiven Tab ab. Um eine
auf einem beliebigen Tab als Lesezeichen speichern möchten, verwenden Sie die Methode DocumentTab.getBookmark(id)
. Diese Methode gibt null
zurück, wenn ein solches Bookmark
-Element auf dem Tab nicht vorhanden ist.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the bookmark by its ID in the document's active or first tab. const bookmark = doc.getBookmark('id.xyz654321'); // If the bookmark exists, logs the character offset of its position to the console. // otherwise, logs 'No bookmark exists with the given ID.' to the console. if (bookmark) { console.log(bookmark.getPosition().getOffset()); } else { console.log('No bookmark exists with the given ID.'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
id | String | Die ID für die Bookmark . |
Rückflug
Bookmark
– Die Bookmark
mit der angegebenen ID oder null
, wenn keine solche Bookmark
vorhanden ist
auf dem Tab vorhanden ist.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmarks()
Ruft alle Bookmark
-Objekte im ersten Tab oder im Fall von Skripts, die an ein Dokument gebunden sind, im aktiven Tab ab. Alle
Lesezeichen auf einem beliebigen Tab öffnen, verwenden Sie die Methode DocumentTab.getBookmarks()
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets all of the bookmarks in the document's active or first tab. const bookmarks = doc.getBookmarks(); // Logs the number of bookmarks in the tab to the console. console.log(bookmarks.length);
Rückflug
Bookmark[]
: Ein Array der Bookmark
-Objekte auf dem Tab.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCursor()
Ruft den Cursor des Nutzers im aktiven Tab ab. Ein Skript kann nur auf den Cursor des Nutzers zugreifen, der das Skript ausführt, und nur dann, wenn es an das Dokument gebunden ist.
// Insert some text at the cursor position and make it bold. var cursor = DocumentApp.getActiveDocument().getCursor(); if (cursor) { // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's // containing element doesn't allow insertions, so show the user an error message. var element = cursor.insertText('ಠ‿ಠ'); if (element) { element.setBold(true); } else { DocumentApp.getUi().alert('Cannot insert text here.'); } } else { DocumentApp.getUi().alert('Cannot find a cursor.'); }
Rückflug
Position
: Darstellung des Cursors des Nutzers oder null
, falls der Nutzer keine
Cursor im Tab oder wenn das Skript nicht an das Dokument gebunden ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getEditors()
Ruft die Liste der Bearbeiter für dieses Document
-Element ab.
Rückflug
User[]
: ein Array von Nutzern mit Bearbeitungsberechtigung.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getFootnotes()
Ruft alle Footnote
-Elemente im Body des ersten Tabs oder im Fall von Skripts, die an ein Dokument gebunden sind, im Body des aktiven Tabs ab. Um
alle Fußnoten auf einem beliebigen Tab können Sie mit der Methode DocumentTab.getFootnotes()
ändern.
Aufrufe von getFootnotes
führen zu einer Iteration der Elemente auf dem Tab. Bei großen Tabs
um unnötige Aufrufe dieser Methode zu vermeiden.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the first footnote in the active or first tab's body. const footnote = doc.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
Rückflug
Footnote[]
: Fußnoten des Tabs
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getHeader()
Ruft den Kopfzeilenbereich des ersten Tabs oder, im Fall von Skripts, die an ein Dokument gebunden sind, den Header des aktiven Tabs ab
. Um den Headerabschnitt eines beliebigen Tabs abzurufen, verwenden Sie die Methode DocumentTab.getHeader()
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the text of the active or first tab's header and logs it to the console. console.log(doc.getHeader().getText());
Rückflug
HeaderSection
: Der Header des Tabs.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getId()
Ruft die eindeutige Kennung des Dokuments ab. Die Dokument-ID wird mit DocumentApp.openById()
verwendet, um eine bestimmte Dokumentinstanz zu öffnen.
Rückflug
String
: Die Dokument-ID.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLanguage()
Ruft den Sprachcode des Dokuments ab. Dies ist die Sprache, die in der Datei Datei > Sprache: Das ist möglicherweise nicht die tatsächliche Sprache des Dokuments.
Rückflug
String
: Die Dokumentsprache oder null
, falls nicht definiert.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getName()
Ruft den Titel des Dokuments ab.
Rückflug
String
: Der Titel des Dokuments.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRangeById(id)
Ruft das NamedRange
mit der angegebenen ID im ersten Tab oder, im Fall von Skripts, die an ein Dokument gebunden sind, den aktiven Tab ab. Um die
NamedRange
mit der angegebenen ID auf einem beliebigen Tab die DocumentTab.getNamedRangeById(id)
. Diese Methode gibt null
zurück, wenn eine solche NamedRange
im Tab nicht vorhanden ist. Namen
nicht unbedingt eindeutig sind, auch über mehrere Tabs hinweg. können verschiedene Bereiche auf demselben Tab
denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Tabs eindeutig,
wie eine ID in HTML.
Parameter
Name | Typ | Beschreibung |
---|---|---|
id | String | Die Bereichs-ID, die innerhalb des Tabs eindeutig ist. |
Rückflug
NamedRange
– Die NamedRange
mit der angegebenen ID oder null
, wenn in der Datei kein solcher Bereich vorhanden ist.
auf dem Tab.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges()
Ruft alle NamedRange
-Objekte im ersten Tab oder im Fall von Skripts, die an ein Dokument gebunden sind, im aktiven Tab ab. Alle
NamedRange
-Objekten auf einem beliebigen Tab verwenden Sie die Methode DocumentTab.getNamedRanges()
.
Ein NamedRange
kann von jedem Skript aufgerufen werden, das auf den Tab zugreift. Um dies zu vermeiden
unbeabsichtigte Konflikte zwischen Skripts haben, können Sie Bereichsnamen einen eindeutigen String voranstellen.
Rückflug
NamedRange[]
: ein Array der NamedRange
-Objekte auf dem Tab, möglicherweise einschließlich mehrerer
Bereiche mit demselben Namen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges(name)
Ruft alle NamedRange
-Objekte mit dem angegebenen Namen im ersten Tab oder für Skripts ab, die
an ein Dokument gebunden sind, den aktiven Tab. Um
für alle NamedRange
-Objekte auf einem beliebigen Tab verwenden möchten, verwenden Sie die Methode DocumentTab.getNamedRanges(name)
. Namen sind nicht unbedingt eindeutig, auch nicht über mehrere Tabs hinweg. in verschiedenen Bereichen
kann ein und dieselbe Registerkarte denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs eindeutig
wie eine ID in HTML.
Ein NamedRange
kann von jedem Skript aufgerufen werden, das auf das Dokument zugreift. Um dies zu vermeiden
unbeabsichtigte Konflikte zwischen Skripts haben, können Sie Bereichsnamen einen eindeutigen String voranstellen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Der Name des Bereichs, der nicht unbedingt eindeutig ist. |
Rückflug
NamedRange[]
: Ein Array der NamedRange
-Objekte im Tab mit dem angegebenen Namen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSelection()
Ruft die Auswahl des Nutzers auf dem aktiven Tab ab. Ein Skript kann nur auf die Auswahl des Nutzers zugreifen wer das Skript ausführt, und nur, wenn es an das Dokument gebunden ist.
// Display a dialog box that tells the user how many elements are included in the selection. var selection = DocumentApp.getActiveDocument().getSelection(); if (selection) { var elements = selection.getRangeElements(); DocumentApp.getUi().alert('Number of selected elements: ' + elements.length); } else { DocumentApp.getUi().alert('Nothing is selected.'); }
Rückflug
Range
: Darstellung der Auswahl des Nutzers oder null
, wenn der Nutzer keine
alle auf dem Tab ausgewählten Elemente, wenn nur das Ende eines Absatzes oder nur das Ende
eines Absatzes und einer neuen Zeile ausgewählt werden oder wenn das Skript nicht an das Dokument gebunden ist.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSupportedLanguageCodes()
Ruft alle Sprachcodes ab, die in Google Docs-Dateien unterstützt werden.
Rückflug
String[]
: ein Array mit Sprachcodes.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTab(tabId)
Ruft die Tab
mit der angegebenen ID ab. Diese Methode gibt null
zurück, wenn eine solche Tab
nicht vorhanden ist. Kann auf Tabs auf jeder Verschachtelungsebene zugreifen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
tabId | String | Die ID des abzurufenden Tabs. |
Rückflug
Tab
: Die Tab
mit der angegebenen ID oder null
, wenn eine solche Tab
nicht existiert.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTabs()
Ruft alle nicht verschachtelten Tab
s ab, die Teil des Dokuments sind.
Tabs können untergeordnete Tabs enthalten, also einen Tab, der in einem anderen Tab verschachtelt ist. Zugriff auf untergeordnete Tabs
mit Tab.getChildTabs()
.
Rückflug
Tab[]
: Die Liste aller Tab
-Elemente, die Teil des Dokuments sind.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getUrl()
Ruft die URL für den Zugriff auf das aktuelle Dokument ab.
var doc = DocumentApp.getActiveDocument(); // Send out the link to open the document. MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());
Rückflug
String
: Die URL für den Zugriff auf das aktuelle Dokument.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getViewers()
Ruft die Liste der Betrachter und Kommentatoren für dieses Document
ab.
Rückflug
User[]
: ein Array von Nutzern mit Berechtigung zum Ansehen oder Kommentieren.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newPosition(element, offset)
Erstellt eine neue Position
, die ein Verweis auf eine Position auf dem Tab ist, relativ zu einem
ein bestimmtes Element auf dem ersten Tab oder bei Skripts, die an ein Dokument gebunden sind, im aktiven Tab. So erstellen Sie ein
Position
relativ zu einem Ort auf einem beliebigen Tab aufrufen, verwenden Sie die DocumentTab.newPosition(element, offset)
. Der Cursor des Nutzers wird unter anderem als Position
dargestellt.
// Append a paragraph to the active tab, then place the user's cursor after the first word of // the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parameter
Name | Typ | Beschreibung |
---|---|---|
element | Element | Das Element, das die neue Position enthalten soll. Dies muss entweder ein
Text -Element oder ein Containerelement wie Paragraph . |
offset | Integer | Bei Text -Elementen die Anzahl der Zeichen vor Position .
bei anderen Elementen die Anzahl der untergeordneten Elemente vor dem Position im
Containerelement. |
Rückflug
Position
– Das neue Position
.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newRange()
Erstellt einen Builder, der zum Erstellen von Range
-Objekten aus Tab-Elementen im
1. Tab oder für Skripts, die an ein gebundenes
der aktive Registerkarte. Zum Erstellen eines Builders, der zum Erstellen von DocumentRange
-Objekten verwendet wird
aus Tab-Elementen auf beliebigen Tabs entfernen, verwenden Sie die Methode DocumentTab.newRange()
.
// Change the user's selection to a range that includes every table in the active tab. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Rückflug
RangeBuilder
: Der neue Builder.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(emailAddress)
Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document
. Bei dieser Methode werden keine
Nutzer am Zugriff auf Document
blockieren, wenn sie zu einer Nutzerklasse gehören, die
allgemeinen Zugriff haben, z. B. wenn die Document
für das gesamte
Domain oder die Document
befindet sich in einer geteilten Ablage, auf die der Nutzer zugreifen kann.
Bei Drive-Dateien wird der Nutzer dadurch auch aus der Betrachterliste entfernt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des zu entfernenden Nutzers. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(user)
Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document
. Bei dieser Methode werden keine
Nutzer am Zugriff auf Document
blockieren, wenn sie zu einer Nutzerklasse gehören, die
allgemeinen Zugriff haben, z. B. wenn die Document
für das gesamte
Domain oder die Document
befindet sich in einer geteilten Ablage, auf die der Nutzer zugreifen kann.
Bei Drive-Dateien wird der Nutzer dadurch auch aus der Betrachterliste entfernt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des zu entfernenden Nutzers. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(emailAddress)
Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Document
. Dieses
hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter, kein Betrachter oder Kommentator ist. Bei dieser Methode
Der Zugriff auf Document
wird nicht blockiert, wenn sie zu einer Klasse von Nutzern gehören, die
allgemeinen Zugriff haben, z. B. wenn die Document
für das
oder wenn sich die Document
in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.
Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Bearbeiter entfernt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des zu entfernenden Nutzers. |
Rückflug
Document
: Diese Document
für die Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(user)
Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Document
. Dieses
hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter und kein Betrachter ist. Diese Methode blockiert auch nicht
Nutzer, die nicht auf die Document
zugreifen, wenn sie zu einer Nutzerklasse mit allgemeinen
Zugriff haben, z. B. wenn die Document
für die gesamte Domain des Nutzers freigegeben ist oder
Document
befindet sich in einer geteilten Ablage, auf die der Nutzer zugreifen kann.
Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Bearbeiter entfernt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des zu entfernenden Nutzers. |
Rückflug
Document
: Diese Document
für die Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
saveAndClose()
Speichert den aktuellen Document
. Veranlasst, dass ausstehende Updates geleert und angewendet werden.
Die Methode saveAndClose()
wird am Ende der Skriptausführung automatisch aufgerufen
für jede geöffnete bearbeitbare Document
.
Ein geschlossener Document
kann nicht bearbeitet werden. DocumentApp.openById()
verwenden, um ein
ein Dokument bearbeiten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setActiveTab(tabId)
Legt das vom Nutzer ausgewählte Tab
im aktuellen Dokument auf den Tab mit der angegebenen ID fest.
const doc = DocumentApp.getActiveDocument() // Sets the user's selected tab by its ID. // TODO(developer): Replace the ID with your own. const tab = doc.setActiveTab(TAB_ID);
Parameter
Name | Typ | Beschreibung |
---|---|---|
tabId | String | Die ID des als aktiv festzulegenden Tabs. |
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setCursor(position)
Legt den Cursor des Nutzers bei Angabe eines Position
fest. Ein Skript kann nur auf den Cursor des
Nutzer, der das Skript ausführt, und nur, wenn es an das Dokument gebunden ist.
Wird ein Position
aus einem inaktiven Tab
angegeben, wechselt der aktive Tab des Nutzers.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Append a paragraph, then place the user's cursor after the first word of the new paragraph. var paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); var position = documentTab.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parameter
Name | Typ | Beschreibung |
---|---|---|
position | Position | Die neue Cursorposition. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLanguage(languageCode)
Legt den Sprachcode des Dokuments fest. Dies ist die Sprache, die in der Datei Datei
> Sprache: Das ist möglicherweise nicht die tatsächliche Sprache des Dokuments. Verwende getSupportedLanguageCodes()
, um alle gültigen Sprachcodes abzurufen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
languageCode | String | Der Sprachcode. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setName(name)
Legt den Titel des Dokuments fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Der neue Dokumenttitel. |
Rückflug
Document
: Das aktuelle Dokument.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSelection(range)
Legt die Auswahl des Nutzers auf dem aktiven Tab fest, wenn eine Range
angegeben wird. Ein Script kann nur
die Auswahl des Nutzers, der das Skript ausführt, nur dann abzurufen, wenn das Skript an das Dokument gebunden ist.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Change the user's selection to a range that includes every table in the document. var rangeBuilder = documentTab.newRange(); var tables = documentTab.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Parameter
Name | Typ | Beschreibung |
---|---|---|
range | Range | Der neue Bereich der auszuwählenden Elemente. |
Rückflug
Document
: Diese Document
zum Verketten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents